home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cato / Xm / Shell.z / Shell
Text File  |  1998-10-20  |  13KB  |  199 lines
  1.  
  2.  
  3.  
  4.      SSSShhhheeeellllllll((((3333XXXX))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 SSSShhhheeeellllllll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           SSSShhhheeeellllllll - The Shell widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXX11111111////SSSShhhheeeellllllll....hhhh>>>>
  14.  
  15.  
  16.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  17.           This page documents version 1.2 of the Motif library.
  18.  
  19.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.           Shell is a top-level widget (with only one managed child)
  21.           that encapsulates the interaction with the window manager.
  22.  
  23.           At the time the shell's child is managed, the child's width
  24.           is used for both widgets if the shell is unrealized and no
  25.           width has been specified for the shell.  Otherwise, the
  26.           shell's width is used for both widgets.  The same relations
  27.           hold for the height of the shell and its child.
  28.  
  29.         CCCCllllaaaasssssssseeeessss
  30.           Shell inherits behavior and resources from CCCCoooommmmppppoooossssiiiitttteeee and
  31.           CCCCoooorrrreeee.
  32.  
  33.           The class pointer is sssshhhheeeellllllllWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  34.  
  35.           The class name is SSSShhhheeeellllllll.
  36.  
  37.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  38.           The following table defines a set of widget resources used
  39.           by the programmer to specify data.  The programmer can also
  40.           set the resource values for the inherited classes to set
  41.           attributes for this widget.  To reference a resource by name
  42.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  43.           prefix and use the remaining letters.  To specify one of the
  44.           defined values for a resource in a .Xdefaults file, remove
  45.           the XXXXmmmm prefix and use the remaining letters (in either
  46.           lowercase or uppercase, but include any underscores between
  47.           words).  The codes in the access column indicate if the
  48.           given resource can be set at creation time (C), set by using
  49.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  50.           not applicable (N/A).
  51.  
  52.                                               SSSShhhheeeellllllll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  53.      NNNNaaaammmmeeee                      CCCCllllaaaassssssss                     TTTTyyyyppppeeee                     DDDDeeeeffffaaaauuuulllltttt          AAAAcccccccceeeessssssss
  54.      ____________________________________________________________________________________________________
  55.      XmNallowShellResize       XmCAllowShellResize       Boolean                  False            CG
  56.      XmNcreatePopupChildProc   XmCCreatePopupChildProc   XtCreatePopupChildProc   NULL             CSG
  57.      XmNgeometry               XmCGeometry               String                   NULL             CSG
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      SSSShhhheeeellllllll((((3333XXXX))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 SSSShhhheeeellllllll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.      XmNoverrideRedirect       XmCOverrideRedirect       Boolean                  False            CSG
  75.      XmNpopdownCallback        XmCCallback               XtCallbackList           NULL             C
  76.      XmNpopupCallback          XmCCallback               XtCallbackList           NULL             C
  77.      XmNsaveUnder              XmCSaveUnder              Boolean                  False            CSG
  78.      XmNvisual                 XmCVisual                 Visual *                 CopyFromParent   CSG
  79.  
  80.  
  81.           XXXXmmmmNNNNaaaalllllllloooowwwwSSSShhhheeeellllllllRRRReeeessssiiiizzzzeeee
  82.                     Specifies that if this resource is False, the
  83.                     Shell widget instance returns XXXXttttGGGGeeeeoooommmmeeeettttrrrryyyyNNNNoooo to all
  84.                     geometry requests from its children.
  85.  
  86.           XXXXmmmmNNNNccccrrrreeeeaaaatttteeeePPPPooooppppuuuuppppCCCChhhhiiiillllddddPPPPrrrroooocccc
  87.                     Specifies the pointer to a function that is called
  88.                     when the Shell widget instance is popped up by
  89.                     XXXXttttPPPPooooppppuuuupppp.  The function creates the child widget
  90.                     when the shell is popped up instead of when the
  91.                     application starts up.  This can be used if the
  92.                     child needs to be reconfigured each time the shell
  93.                     is popped up.  The function takes one argument,
  94.                     the popup shell, and returns no result.  It is
  95.                     called after the popup callbacks specified by
  96.                     XXXXmmmmNNNNppppooooppppuuuuppppCCCCaaaallllllllbbbbaaaacccckkkk.
  97.  
  98.           XXXXmmmmNNNNggggeeeeoooommmmeeeettttrrrryyyy
  99.                     Specifies the desired geometry for the widget
  100.                     instance.  This resource is examined only when the
  101.                     widget instance is unrealized and the number of
  102.                     its managed children is changed.  It is to change
  103.                     the values of the XXXXmmmmNNNNxxxx, XXXXmmmmNNNNyyyy, XXXXmmmmNNNNwwwwiiiiddddtttthhhh, and
  104.                     XXXXmmmmNNNNhhhheeeeiiiigggghhhhtttt resources.
  105.  
  106.           XXXXmmmmNNNNoooovvvveeeerrrrrrrriiiiddddeeeeRRRReeeeddddiiiirrrreeeecccctttt
  107.                     Specifies this is True if the widget instance is a
  108.                     temporary window which should be ignored by the
  109.                     window manager.  Applications and users should not
  110.                     normally alter this resource.
  111.  
  112.           XXXXmmmmNNNNppppooooppppddddoooowwwwnnnnCCCCaaaallllllllbbbbaaaacccckkkk
  113.                     Specifies a list of callbacks that is called when
  114.                     the widget instance is popped down by XXXXttttPPPPooooppppddddoooowwwwnnnn.
  115.  
  116.           XXXXmmmmNNNNppppooooppppuuuuppppCCCCaaaallllllllbbbbaaaacccckkkk
  117.                     Specifies a list of callbacks that is called when
  118.                     the widget instance is popped up by XXXXttttPPPPooooppppuuuupppp.
  119.  
  120.           XXXXmmmmNNNNssssaaaavvvveeeeUUUUnnnnddddeeeerrrr
  121.                     Specifies a True value if it is desirable to save
  122.                     the contents of the screen beneath this widget
  123.                     instance, avoiding expose events when the instance
  124.                     is unmapped.  This is a hint, and an
  125.                     implementation may save contents whenever it
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      SSSShhhheeeellllllll((((3333XXXX))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 SSSShhhheeeellllllll((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     desires, including always or never.
  141.  
  142.           XXXXmmmmNNNNvvvviiiissssuuuuaaaallll Specifies the visual used in creating the widget.
  143.  
  144.  
  145.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  146.           Shell inherits behavior and resources from the following
  147.           superclass.  For a complete description of each resource,
  148.           refer to the man page for that superclass.
  149.  
  150.                              CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  151.      NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  152.      ______________________________________________________________________
  153.      XmNchildren         XmCReadOnly         WidgetList    NULL      G
  154.      XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  155.      XmNnumChildren      XmCReadOnly         Cardinal      0         G
  156.  
  157.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  158.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  159.      ______________________________________________________________________________________________________________
  160.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  161.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  162.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  163.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  164.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  165.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  166.      XmNborderWidth                  XmCBorderWidth                  Dimension        1                      CSG
  167.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  168.      XmNdepth                        XmCDepth                        int              dynamic                CG
  169.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  170.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  171.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  172.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  173.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  174.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  175.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  176.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  177.      XmNx                            XmCPosition                     Position         0                      CSG
  178.      XmNy                            XmCPosition                     Position         0                      CSG
  179.  
  180.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  181.           There are no translations for Shell.
  182.  
  183.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  184.           CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX)))) and CCCCoooorrrreeee((((3333XXXX)))).
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.